iT邦幫忙

2024 iThome 鐵人賽

DAY 22
0
生成式 AI

API: Swagger, Postman系列 第 22

結合 Postman 和 Swagger:如何導出 Swagger 文檔到 Postman。

  • 分享至 

  • xImage
  •  

將 Swagger 文檔導出到 Postman,可以方便地使用 Postman 進行 API 測試和調試。具體步驟如下:

方法一:使用 Swagger JSON 直接導入 Postman

  1. 獲取 Swagger JSON 文件

    • 在你的 Swagger UI 頁面上,找到導出 API 定義的選項。通常,Swagger 提供一個下載 JSON 文件的鏈接。這個鏈接通常顯示為 “Download JSON” 或者你可以在 Swagger URL 後加上 /swagger.json
    • 獲得這個鏈接或下載文件。
  2. 打開 Postman

    • 在 Postman 中打開應用,然後選擇左側的 “Collections” 標籤。
  3. 導入 Swagger 文檔

    • 點擊右上角的 “Import” 按鈕。
    • 選擇 LinkFile 方式進行導入。如果你有 Swagger 的 JSON 文件鏈接,可以直接粘貼到 Postman 中。如果你已經下載了該文件,選擇 File 選項並上傳文件。
  4. 完成導入

    • Postman 將自動分析 Swagger 文檔並生成一個對應的 API 集合。這樣你就可以使用 Postman 測試 API 了。

方法二:通過 OpenAPI 3.0 定義

如果你的 Swagger 文檔是基於 OpenAPI 3.0 格式的,步驟相同:

  1. 獲取 OpenAPI 定義文件的 JSON 或 YAML。
  2. 在 Postman 中使用 Import 功能,選擇對應的文件或鏈接。
  3. Postman 將自動轉換 OpenAPI 定義為 Postman Collection。

方法三:直接在 Postman 中集成 Swagger(適用於最新版本)

  1. 打開 Postman,進入主界面後,點擊左側導航欄的 API
  2. 點擊 + New API,然後選擇 Import from Swagger/OpenAPI
  3. 將 Swagger 文檔的 URL 粘貼到對應欄位,然後點擊 Generate Collection,Postman 將自動生成對應的 API 集合。

常見問題:

  • 不兼容的版本:如果 Swagger 文檔格式有問題,Postman 可能會無法識別。確認 Swagger 文檔的格式正確,並且是 OpenAPI 2.0 或 3.0 格式。
  • 自簽名證書問題:在導入 HTTPS 服務的 Swagger 文檔時,如果有自簽名證書問題,請確保 Postman 已經正確配置忽略 SSL 錯誤。

上一篇
如何在 Swagger 中管理 API 版本。
下一篇
使用 Postman 測試 Swagger 定義的 API。
系列文
API: Swagger, Postman30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言